
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>smp.derivs_inner &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="smp.derivs_outer" href="smp.derivs_outer.html" />
    <link rel="prev" title="stratified_plume_model.particle_from_mb0" href="stratified_plume_model.particle_from_mb0.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="smp-derivs-inner">
<h1>smp.derivs_inner<a class="headerlink" href="#smp-derivs-inner" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="smp.derivs_inner">
<code class="sig-prename descclassname">smp.</code><code class="sig-name descname">derivs_inner</code><span class="sig-paren">(</span><em class="sig-param">z</em>, <em class="sig-param">y</em>, <em class="sig-param">yi</em>, <em class="sig-param">yo</em>, <em class="sig-param">particles</em>, <em class="sig-param">profile</em>, <em class="sig-param">p</em>, <em class="sig-param">neighbor</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/smp.html#derivs_inner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smp.derivs_inner" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate the derivatives for the system of ODEs for the inner plume</p>
<p>Calculates the right-hand-side of the system of ODEs for the inner plume
state space.  These equations follow Socolofsky et al. (2008) very 
closely, with the exception that multiple dispersed phase particles are
allowed within the inner plume.  Heat transfer between the dispersed
and continuous phase is also added.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>z</strong><span class="classifier">float</span></dt><dd><p>Current value for the independent variable (depth in m).</p>
</dd>
<dt><strong>y</strong><span class="classifier">ndarray</span></dt><dd><p>Current value for the inner plume state space vector.</p>
</dd>
<dt><strong>yi</strong><span class="classifier"><cite>InnerPlume</cite></span></dt><dd><p>Object for manipulating the inner plume state space</p>
</dd>
<dt><strong>yo</strong><span class="classifier"><cite>OuterPlume</cite></span></dt><dd><p>Object for manipulating the outer plume state space</p>
</dd>
<dt><strong>particles</strong><span class="classifier">list of <cite>Particle</cite> objects</span></dt><dd><p>List of <cite>Particle</cite> objects containing the dispersed phase local
conditions and behavior.</p>
</dd>
<dt><strong>profile</strong><span class="classifier"><cite>ambient.Profile</cite> object</span></dt><dd><p>The ambient CTD object used by the simulation.</p>
</dd>
<dt><strong>p</strong><span class="classifier"><cite>ModelParams</cite> object</span></dt><dd><p>Object containing the fixed model parameters for the stratified 
plume model.</p>
</dd>
<dt><strong>neighbor</strong><span class="classifier"><cite>scipy.interpolate.interp1d</cite> object</span></dt><dd><p>Container holding the latest solution for the outer plume state
space</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>yp</strong><span class="classifier">ndarray</span></dt><dd><p>A vector of the derivatives of the inner plume state space.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="stratified_plume_model.InnerPlume.html#stratified_plume_model.InnerPlume" title="stratified_plume_model.InnerPlume"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stratified_plume_model.InnerPlume</span></code></a>, <a class="reference internal" href="stratified_plume_model.OuterPlume.html#stratified_plume_model.OuterPlume" title="stratified_plume_model.OuterPlume"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stratified_plume_model.OuterPlume</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="stratified_plume_model.inner_main.html#stratified_plume_model.inner_main" title="stratified_plume_model.inner_main"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stratified_plume_model.inner_main</span></code></a>, <a class="reference internal" href="smp.calculate.html#smp.calculate" title="smp.calculate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">calculate</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>It is important that the inner plume entrains fluid from either the 
ambient water (whenever the outer plume is not present) or the outer 
plume (whenever it is shrouding the inner plume).  This is accomplished
in <cite>stratified_plume_model.OuterPlume</cite>:  if there is no outer plume 
segment, then the ambient conditions are stored in the outer plume 
variables.  Thus, <cite>yo.c[i]</cite> is equivalent to <cite>ca[i]</cite> when there is no 
outer plume.  This behavior is true for temperature, salinity, density
and concentration.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/spm.html">Overview of Stratified Plume Model Module</a><ul>
      <li>Previous: <a href="stratified_plume_model.particle_from_mb0.html" title="previous chapter">stratified_plume_model.particle_from_mb0</a></li>
      <li>Next: <a href="smp.derivs_outer.html" title="next chapter">smp.derivs_outer</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/spm/smp.derivs_inner.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>